home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xm / MrmFetchWidget.z / MrmFetchWidget
Encoding:
Text File  |  2002-10-03  |  6.4 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt - Fetches and creates an indexed (UIL named)
  10.           application widget and its children
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Mrm/MrmPublic.h>
  14.           CCCCaaaarrrrddddiiiinnnnaaaallll MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt(
  15.           MMMMrrrrmmmmHHHHiiiieeeerrrraaaarrrrcccchhhhyyyy hhhhiiiieeeerrrraaaarrrrcccchhhhyyyy____iiiidddd,
  16.           SSSSttttrrrriiiinnnngggg iiiinnnnddddeeeexxxx,
  17.           WWWWiiiiddddggggeeeetttt ppppaaaarrrreeeennnntttt____wwwwiiiiddddggggeeeetttt,
  18.           WWWWiiiiddddggggeeeetttt ****wwwwiiiiddddggggeeeetttt,
  19.           MMMMrrrrmmmmTTTTyyyyppppeeee ****ccccllllaaaassssssss);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           The MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeettttfunction fetches and creates an indexed
  26.           application widget and its children.  The indexed
  27.           application widget is any widget that is named in UIL.  In
  28.           fetch operations, the fetched widget's subtree is also
  29.           fetched and created.  This widget must not appear as the
  30.           child of a widget within its own subtree. MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt
  31.           does not execute XXXXttttMMMMaaaannnnaaaaggggeeeeCCCChhhhiiiillllddddfor the newly created widget.
  32.  
  33.           All widgets fetched by a call to MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt are not
  34.           managed at the time of their creation callbacks.
  35.  
  36.           _h_i_e_r_a_r_c_h_y__i_d
  37.                     Specifies the ID of the _U_I_D hierarchy that
  38.                     contains the interface definition.  The value of
  39.                     _h_i_e_r_a_r_c_h_y__i_d was returned in a previous call to
  40.                     MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy.
  41.  
  42.           _i_n_d_e_x     Specifies the UIL name of the widget to fetch.
  43.  
  44.           _p_a_r_e_n_t__w_i_d_g_e_t
  45.                     Specifies the parent widget ID.
  46.  
  47.           _w_i_d_g_e_t    Returns the widget ID of the created widget.
  48.  
  49.           _c_l_a_s_s     This argument must be set to an actual pointer; it
  50.                     cannot be a NULL pointer. MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt sets this
  51.                     argument to an implementation dependent value.
  52.  
  53.           An application can fetch any named widget in the _U_I_D
  54.           hierarchy using MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt.  MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeettttcan be called
  55.           at any time to fetch a widget that was not fetched at
  56.           application startup.  MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeettttcan be used to defer
  57.           fetching pop-up widgets until they are first referenced
  58.           (presumably in a callback), and then used to fetch them
  59.           once.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))        UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV        MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeettttcan also create multiple instances of a widget
  75.           (and its subtree).  In this case, the _U_I_D definition
  76.           functions as a template; a widget definition can be fetched
  77.           any number of times.  An application can use this template
  78.           to make multiple instances of a widget, for example, in a
  79.           dialog box box or menu.
  80.  
  81.           The index (UIL name) that identifies the widget must be
  82.           known to the application.
  83.  
  84.      RRRREEEETTTTUUUURRRRNNNN
  85.           This function returns one of the following status return
  86.           constants:
  87.  
  88.           MMMMrrrrmmmmSSSSUUUUCCCCCCCCEEEESSSSSSSS
  89.                     The function executed successfully.
  90.  
  91.           MMMMrrrrmmmmBBBBAAAADDDD____HHHHIIIIEEEERRRRAAAARRRRCCCCHHHHYYYY
  92.                     The hierarchy ID was invalid.
  93.  
  94.           MMMMrrrrmmmmNNNNOOOOTTTT____FFFFOOOOUUUUNNNNDDDD
  95.                     The widget was not found in UID hierarchy.
  96.  
  97.           MMMMrrrrmmmmFFFFAAAAIIIILLLLUUUURRRREEEE
  98.                     The function failed.
  99.  
  100.      RRRREEEELLLLAAAATTTTEEEEDDDD
  101.           MMMMrrrrmmmmOOOOppppeeeennnnHHHHiiiieeeerrrraaaarrrrcccchhhhyyyyPPPPeeeerrrrDDDDiiiissssppppllllaaaayyyy(3), MMMMrrrrmmmmFFFFeeeettttcccchhhhWWWWiiiiddddggggeeeettttOOOOvvvveeeerrrrrrrriiiiddddeeee(3).
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.